[6.x] Fix nullable return types in form docblocks#15018
Closed
jasonbaciulis wants to merge 1 commit into
Closed
Conversation
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Problem
Several docblocks in the Forms domain declare non-nullable return types for methods that can return
null:Form::submission($id)(concrete class and contract) is annotated@return Submission, but it delegates toFormSubmission::find($id), whose repository implementation returns?Submission.FormSubmissionfacade annotates@method static SubmissionContract find($id)for the same nullable lookup.FormRepository::find($handle)is annotated@return FormContract, but returnsnullwhen the form's YAML file doesn't exist, and theFormfacade's@methodannotation repeats the non-nullable type.This breaks static analysis in apps consuming Statamic. For example, PHPStan (with default
treatPhpDocTypesAsCertain: true) reports a guard like this as dead code:…even though the null check is genuinely reachable at runtime. It also gives IDEs false confidence, hiding potential null-dereference bugs.
Solution
Correct the five docblocks to
|null, matching what the methods actually return. Docblock-only change — no behavior changes, so no new test case.